sdgraphobjectcomment module

class sd.api.sdgraphobjectcomment.SDGraphObjectComment(APIContext, handle, *args, **kwargs)

Bases: sd.api.sdgraphobject.SDGraphObject

Class managing a Comment object in the graph

getClassName() → str

Returns the most specific name of the class this APIObject is

getDescription() → str

Get the SDGraphObject description

getParent() → Optional[sd.api.sdnode.SDNode]

Get the parent node of the current SDGraphObjectComment

getPosition() → sd.api.sdbasetypes.float2

Get the SDGraphObject position

release() → None

Releases an APIObject

static sNew(sdGraph: sd.api.sdgraph.SDGraph) → sd.api.sdgraphobjectcomment.SDGraphObjectComment

Create a new SDGraphObjectComment instance in the specified graph

Parameters

sdGraph – The SDGraph that should contains the new SDGraphObjectComment

static sNewAsChild(sdNode: sd.api.sdnode.SDNode) → sd.api.sdgraphobjectcomment.SDGraphObjectComment

Create a new SDGraphObjectComment instance attached to the specified parent node

Parameters

sdNode – The SDNode used to attach the new SDGraphObjectComment instance

setDescription(value: str) → None

Set the SDGraphObject description

Parameters

value – The new description

setPosition(position: sd.api.sdbasetypes.float2) → None

Set the SDGraphObject position

Parameters

position – The new position in the graph